Motion.SetAxisTouchProbe 方法
發生觸發事件時,記錄軸的位置。
命名空間:IntervalZero.KINGSTAR.Local.Api
組合: IntervalZero.KINGSTAR.Local.Api (於 IntervalZero.KINGSTAR.Local.dll) 版本:4.4.0.0
語法
public KsCommandStatus<double> SetAxisTouchProbe(
int Index,
McProbeTrigger TriggerInput,
bool WindowOnly,
double firstPosition,
double lastPosition
)
Public Function SetAxisTouchProbe(
Index As Integer,
TriggerInput As McProbeTrigger,
WindowOnly As Boolean,
firstPosition As Double,
lastPosition As Double
) As KsCommandStatus(Of Double)
參數
Index [in]
型別:int
軸索引。索引以 0 為起始;別名將影響此參數。
TriggerInput [in]
觸發訊號來源。觸發可由 Index 指定。
WindowOnly [in]
型別:bool
若設定,則只有在視窗內的值可用來觸發事件,視窗範圍介於 firstPosition 與 lastPosition 之間。
firstPosition [in]
型別:double
觸發事件被認定時的起始位置(正向;使用者單位),值包含在視窗中。目前支援 firstPosition 須小於 lastPosition。
lastPosition [in]
型別:double
視窗內的結束位置(使用者單位),值包含在視窗中。
回傳值
回傳一個方法的狀態及一個 double 值。
備註
- 欲使用此方法,必須使用 Api.EnableTouchProbe 啟動位置抓取功能。
- 一個方法實例僅代表一個位置抓取命令。
- 為避免同一個探針與軸上有多個實例,應使用具有唯一識別的
TouchProbeId
探針命令來擴充 McProbeTrigger 元素,可連結至 Api.AbortCommand。 - SetAxisTouchProbe 完成後,須等待一個週期,位置抓取才會生效。
- 欲了解位置抓取功能的詳細資訊,請參見 概念解說 > 位置抓取功能 (Touch Probe)。
- 當模數軸啟用時,模數值會套用至 firstPosition 與 lastPosition 參數,以及回傳指令狀態中的輸出值。
範例
N/A
參見